cisco-cvp-ux

(0 reviews)

DeviceReset - TMF639

Key Considerations

Input body will contain service number and account number.
Equipments for account level and service level are retrieved from cerillion API.
After equipment/device validation, request is sent to RESOLVE to reset the Modem.
RESOLVE has the capability to only handle the HFC Requests. so the services with network types HFC only will be considered and services with network types FTTH will not be accepted by RESOLVE.
Device Reset will be only applicable for FIXED Services
This is applicable only for JM Business Unit

URL

https://[localhost]:[port]/cisco-cvp-ux/v1/{businessId}/reset

URI PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (JM) identifying the business unit. Enum values:AG,BB,BS,GD,JM,LC,TT,VC,PR	Y

Headers

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N
lob	string	Enum: PREPAID, POSTPAID,FIXED Mobile users: PREPAID, POSTPAID Fixed users : FIXED	N

Request Body

{
   "accountNumber": "50143799",
    "serviceNumber": "DA0000582334"
}

Note: For Modem device, serviceType should be of DA.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[200]-CWC-Success Response when deviceClass is Modem and BU is JM:

{
  "id": "31bf09cf5595d5d7b5a427c1faf239fb",
  "resourceStatus": "Success",
  "administrativeState": "unlocked",
  "resourceCharacteristic": [
    {
      "id": "9257708",
      "name": "modem",
      "value": "EQJAHDVM",
      "valueType": "tariffCode",
      "characteristicRelationship": [
        {
          "id": "90C792DD1582",
          "@type": "serialNo"
        },
        {
          "id": "31bf09cf5595d5d7b5a427c1faf239fb",
          "@type": "requestId"
        },
        {
          "id": "ivr_result#resolve.ivr.util",
          "@type": "operationCode"
        }
      ],
      "@type": "MODEM"
    }
  ],
  "relatedparty": [
    {
      "id": "DA0000582334",
      "@type": "ServiceNo"
    },
    {
      "id": "50143799",
      "@type": "AccountNo"
    }
  ]
}